home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / tools / packer / epugui / epu_gui.doc < prev    next >
Text File  |  1995-03-09  |  8KB  |  198 lines
  1.                              Code 16 Presents
  2.  
  3.                   The EPU Graphical User Interface System
  4.  
  5.  
  6. Introduction
  7. ------------
  8.  
  9. The EPU pd program provides the hard disk owner with a method of
  10. automatically packing and depacking programs and data files transparently
  11. while using his/her computer in the normal way.  The claimed rates of
  12. compression are in the region of being able to store 150Mb on an 80Mb HD.
  13. This all sounds very good - where's the catch?
  14.  
  15. EPU is a CLI based program, and whereas it is easy to install and use, if
  16. you wish to change the options (auto compress on save, for example) for any
  17. reason you need to open a CLI window and type a command such as this
  18.  
  19. EPU dev dh1 nosave chng
  20.  
  21. To some people, this represents no hardship, however, to others, a
  22. graphical system, such as the one integrated into the commercial program
  23. 'Disk Expander' is a much preferable state of affairs.  That is the reason
  24. we wrote EPUGUI.
  25.  
  26. EPUGUI does away with the need for any CLI usage, all that is required to
  27. (for example) switch off automatic compression upon saving is to click on
  28. the correct button with your mouse.
  29.  
  30. However, due to the gadtools gadgets used in EPUGUI, KS2.0 or higher is
  31. required to run it.
  32.  
  33. If you have any comments, queries or suggestions, please e-mail to
  34.                 djl102@unix.york.ac.uk
  35.                 car100@unix.york.ac.uk
  36.  
  37. Alternatively, if you have no e-mail access, then write to
  38.                 Code 16
  39.                 10 Siward Street
  40.                 Hull Road
  41.                 York
  42.                 YO1 3LW
  43.                 ENGLAND
  44.  
  45. e-mail is much more likely to recieve a reply, and the reply will be much
  46. faster than snail mail.
  47.  
  48.  
  49.  
  50.  
  51. Installation
  52. ------------
  53.  
  54. Installation of the EPUGUI program is very easy - simply run the supplied
  55. install program from the WB.  This program will prompt you for a place to
  56. put the EPUGUI program, and will copy a datafile into your s: directory.
  57. Alternatively you can simply copy the datafile object.obj into the s:
  58. directory, and the program files (program+icon) wherever you wish.
  59.  
  60.  
  61.  
  62.  
  63. How to run EPUGUI
  64. -----------------
  65.  
  66. EPUGUI recognises where you ran it from, so for example, if you double click
  67. on the program icon from the WB then the program window is opened on the
  68. workbench screen.  If the program is run from the CLI then the window will
  69. open on the foremost public screen.
  70.  
  71. For EPUGUI to work, you must have the EPU system installed onto your
  72. system.  EPUGUI expects to be able to access EPU through the normal path
  73. assignments (ie. EPU must be executable as a CLI command).  You must also
  74. have your compression libraries in the libs: folder, and they must be named
  75. as follows:
  76.  
  77. epu? where ? is a number.  Currently only 0 and 1 are supplied with EPU.
  78.  
  79. xpk???? where ???? is a name such as NUKE.
  80.  
  81. This is the standard xpk name
  82. format, and so all xpk compression libraries should conform to this
  83. already.  Encryption libraries will be displayed in the compressor
  84. selection window, but usage should be avoided since EPU does not support
  85. libraries that require a password.
  86.  
  87.  
  88.  
  89.  
  90. Using EPUGUI
  91. ------------
  92.  
  93. EPUGUI is extremely easy to use, all that is required is a little knowledge
  94. of how the EPU system works.
  95.  
  96. (skip this if you have bothered to read the EPU docs - because it is all in
  97. there anyway)
  98. EPU has a number of options which are supplied by the user to control it's
  99. operation.  When using EPU through the CLI, these are as follows:
  100.  
  101. LOAD/NOLOAD     This tells EPU whether you wish to have it automatically
  102.                 decompress compressed files when they are encountered.
  103.  
  104. SAVE/NOSAVE     This tells EPU if you wish to have all files saved
  105.                 automatically compressed or not.
  106.  
  107. EXAM/NOEXAM     This tells EPU if you wish to see the uncompressed or the
  108.                 compressed file size in a directory listing.
  109.  
  110. EXNEXT/NOEXNEXT If EXNEXT is specified, then the directory size in, for
  111.                 example, a 'list' of a directory will be the uncompressed
  112.                 size.  Otherwise, the compressed size will be used.
  113.  
  114. HMODE/LMODE     LMODE forces EPU to always compress a file (as long as SAVE
  115.                 is specified), but if HMODE is set, the file will only be
  116.                 compressed if the compressed size is smaller than the real
  117.                 size.
  118.  
  119. BLOCK           The block size is the size of memory allocated per block.
  120.                 Larger amounts mean better and faster compression rates.
  121.  
  122. TABLE           The table size is the max number of blocks per file.
  123.  
  124. LIB             The lib name is the name of the compression library to be
  125.                 used.
  126.  
  127. EPUGUI has all of the above options, however, for the LOAD/NOLOAD etc.
  128. options, a checkbox is provided.  A check in the box means the option is
  129. enabled, no check means not enabled.  For the HMODE/LMODE parameter, a
  130. check means HMODE, no check LMODE.
  131.  
  132. The BLOCK and TABLE parameters have a numerical text entry box supplied -
  133. simply click on the gadget and type the value you require.
  134.  
  135. The LIB parameter is provided with a straight text entry box, which has two
  136. modes of operation - you can either enter the library name straight into
  137. the box, or if you click on the fileselector gadget then a window will open
  138. with a slidable list of all xpk and epu libraries for you select one.
  139.  
  140. 5 other gadgets are also displayed - These are:
  141.  
  142. Device                  A text gadget which displays the currently selected
  143.                         device.
  144. Device Fileselect       A small icon next to the Device gadget, which
  145.                         brings up a fileselector.
  146. Install                 This button will install EPU to the device
  147.                         specified.
  148. Remove                  This button will remove EPU from the specified
  149.                         device.
  150. Modify User-Startup     This button will place some lines at the end of
  151.                         your User-Startup script to run EPU with the
  152.                         specified device and parameters every time the
  153.                         computer is booted from the current system
  154.                         partition.
  155.  
  156. EPUGUI runs as a commodity, allowing you to control the program from
  157. Commodore's supplied Exchange program.  This program lets you enable,
  158. disable, hide and reopen the user interface, and quit the program.
  159.  
  160.  
  161. For more information on how EPU works, refer to the docs included with it.
  162.  
  163. Late Add-ons to EPU-GUI
  164. ----------------------
  165.  
  166. ToolTypes
  167. ---------
  168.  
  169. EPU-GUI now accepts ToolTypes so that you can alter the default 
  170. configuration to whatever you like. To change them, click on EPU-GUI`s 
  171. icon in the directory that you have it stored (or make an icon and select 
  172. it), then select the Icon/Information menu option (on Workbench).
  173.  
  174. The ToolTypes supported are:
  175.  
  176. DONOTWAIT - not used by EPU-GUI, but tells Workbench not to wait for the 
  177. program to exit. Use this if you want to run EPU-GUI from your WBStartup 
  178. drawer extra. BUT MAKE IT THE FIRST TOOLTYPE IN THE LIST
  179.  
  180. CX_POPUP - If YES (CX_POPUP=YES) then the window will open when the 
  181. program is run, if NO then it doesn`t. Default is YES.
  182.  
  183. CX_POPKEY - Set this to the key you wish to use to pop open the window. 
  184. Default is ctrl lalt e. Examples are lalt lshift r and rcommand e   etc.
  185.  
  186. DEVICE - This sets the device to check when the program is started. Set 
  187. this to a device with EPU installed on if you can. eg WORK:
  188.  
  189.  
  190. Commodities
  191. -----------
  192.  
  193. EPU-GUI runs as a Commodity, and can be controlled via the Exchange 
  194. program supplied with Workbench. The window can be opened, closed, enabled 
  195. or disabled, plus the program can be quit from Exchange. Also, the window 
  196. can be forced to open by pressing a Hotkey - see the tooltypes section 
  197. above for how to set the hotkey.
  198.